home *** CD-ROM | disk | FTP | other *** search
/ Gamers Delight 2 / Gamers Delight 2.iso / Aminet / game / wb / WinTris_111.lha / WinTris_v1.11 / WinTris / WinTris.doc < prev    next >
Text File  |  1994-12-10  |  15KB  |  369 lines
  1. ==============================================================================
  2.                         ===     WinTris v1.11     ===
  3.                          == by Gothmog / Spicelab ==
  4.                           =   - documentation -   =
  5. ==============================================================================
  6.  
  7.  0. Table of contents
  8. ------------------------------------------------------------------------------
  9.  1. Disclaimer
  10.  2. Introduction
  11.  3. Requirements
  12.  4. Installation
  13.  5. Configuration
  14.  6. Playing WinTris
  15.  7. Known bugs
  16.  8. Plans for the future
  17.  9. Copying WinTris
  18. 10. Registration
  19. 11. A few wise words
  20. 12. Thanks
  21. 13. History
  22. ------------------------------------------------------------------------------
  23.  
  24.  1. Disclaimer
  25. ------------------------------------------------------------------------------
  26. Although this case is most unprobable, the author does not take any responsi-
  27. bility for any damages to your system caused by this software.
  28. ------------------------------------------------------------------------------
  29.  
  30.  2. Another Tetris? What's the use?
  31. ------------------------------------------------------------------------------
  32. I got the idea to write an own Tetris clone when I found myself disappointed
  33. of SizeTris. The idea behind SizeTris, to write a size flexible multitasking
  34. Tetris, was really good, but I felt disgusted by the presentation.
  35. So I took the challenge and wrote my own one, offering the following features,
  36. to name just a few:
  37.  
  38.   * Multitasking: play WT while making backups, packing data or whatever else
  39.  
  40.   * Full Kickstart 2.0+ support (including 3D-Look)
  41.  
  42.   * Flexible field and tile size
  43.  
  44.   * Preferences Window
  45.  
  46.   * Configuration, sizes and window positions may be saved to disk
  47.  
  48.   * Saveable scorelist
  49.  
  50.   * Complete game status displayed in a separate window
  51.  
  52.   * Auto-pause when window becomes inactive; useful while making backups etc.
  53.  
  54.   * Changeable tile colour and pattern
  55.  
  56.   * Special graphics adaption for non-interlace mode
  57.  
  58. In fact, I don't know any better Workbench Tetris clone. If you do, why not
  59. send me a copy of it or tell me what to improve - I'll try to do my best to
  60. make WinTris be your choice.
  61. ------------------------------------------------------------------------------
  62.  
  63.  3. Requirements
  64. ------------------------------------------------------------------------------
  65. All you need is an Amiga (oh, really?) with Kickstart 2.0 or higher.
  66. ------------------------------------------------------------------------------
  67.  
  68.  4. Installing WinTris
  69. ------------------------------------------------------------------------------
  70. Just pull the whole WinTris Drawer to wherever you want. Then you must install
  71. "libs20/reqtools.library" to your libs: directory (if you really haven't yet).
  72. That's all.
  73. Note: If you are using ToolManager or any similar tool, remember to set the
  74.       current directory to your WinTris directory, e.g. "dh0:games/WinTris".
  75. ------------------------------------------------------------------------------
  76.  
  77.  5. Configuring WinTris
  78. ------------------------------------------------------------------------------
  79. * Sizing the window:
  80.   You may change the window size by using the size gadget in the right bottom
  81.   corner in order to change the tile size. The tile size means the size of a
  82.   single square element in pixels. Minimum is 6, maximum is 64.
  83.   After releasing the size gadget the program reduces the window size to the
  84.   next lower tile size. Only even values are supported, since in nolace mode
  85.   the vertical needs to be divided by two.
  86.   Warning: In the current version, resizing the window will reset the game!
  87.  
  88. - <PREFS>
  89.  
  90. * Prefs/StartLevel:
  91.   Well, uh, actually this determines the level to start at.
  92.   Normally, the level is raised every 20 lines you complete. If, for instance,
  93.   you raise the start level to 5, you will have to complete 6*20=120 lines to
  94.   reach level 6. 
  95.  
  96. * Prefs/HelpLines:
  97.   I couldn't find an advantage in this, but some people liked it.
  98.   Just check it out!
  99.  
  100. * Prefs/X-Size, Y-Size:
  101.   This is the size of the whole field. Minimum is 4*4, maximum is 64*64.
  102.   Note: The original Tetris size is 10*20 (I guess so), this is the default.
  103.         On Game Boy, however, it is 10*17. Change it if you dare!
  104.  
  105. * Prefs/Interlace Graphics:
  106.   WinTris was originally designed for interlace usage. If you deactivate it,
  107.   the vertical brick size will be divided by 2, so that the bricks will 
  108.   appear square in normal HiRes mode.
  109.   (Sorry, no adaption for "Next" display yet!)
  110.  
  111. * Prefs/TaskPri:
  112.   Here you may vary the task priority of WinTris. Since it is a multitasking
  113.   program, this is quite useful. A high TaskPri will make WinTris run
  114.   smoothly in almost every situation. A low TaskPri will give more CPU time
  115.   to other tasks, for instance backup programs or packers.
  116.   A value of 0 is reasonable in most cases.
  117.  
  118. * Prefs/Tile Graphics:
  119.   In WinTris v1.00, the tiles were built up using basic square elements.
  120.   In v1.10, I changed this to gain the original Tetris look. Now you may
  121.   choose between both display modes:
  122.  
  123.     |STD| is the standard Tetris tile,
  124.  
  125.     :SQU: is the tile built up from squares like in WT v1.00.
  126.  
  127. * Prefs/Tile Pattern:
  128.   If you change the pattern, remember to choose different A and B colours.
  129.   Otherwise, you won't see any pattern at all.
  130.   Note: If you are using a tile size which is not a multible of 4, especially
  131.         in non-interlace mode, some more complex patterns may appear
  132.         truncated when used. This is because the graphic elements are not
  133.         filled in realtime. It's not a bug.
  134.  
  135. * Prefs/Tile Colour:
  136.   Both A and B colours, which are needed to paint a two-coloured pattern.
  137.  
  138. * Prefs/Tile Size:
  139.   This is for information purposes only. On the left, you can see the current
  140.   tile size, on the right appears a precalculation of the tile size after
  141.   clicking on USE.
  142.  
  143. - <MENU>
  144.  
  145. * Menu/Load Config:
  146.   will load and use a previously saved prefs file.
  147.  
  148. * Menu/Save Config:
  149.   will save the current configuration to (hard)disk. It will automatically be
  150.   loaded on next startup.
  151.  
  152. * Menu/Default Config:
  153.   restores the original configuration.
  154.  
  155. * Menu/Reset Scorelist:
  156.   will reset the high score list to its original state (and ask you before).
  157.  
  158. * Menu/Clear Scorelist:
  159.   will remove ALL names and scores from the high score table.
  160.   Do you really want to start playing with an initial highscore of 0 ...?
  161.   What's the challenge?
  162. ------------------------------------------------------------------------------
  163.  
  164.  6. Playing WinTris
  165. ------------------------------------------------------------------------------
  166. Press any key (except Amiga-key combinations) to start from "Get Ready" mode.
  167. WinTris is (at the moment) entirely keyboard-controlled:
  168.  
  169. A) Cursor Keys (simple)                B) Number Pad (recommended)
  170.  
  171.              --------                      -------- -------- --------
  172.             | rotate |                    |4 rotate|5 rotate|6 rotate|
  173.             |  left  |                    |   left |   left |  right |
  174.     -------- -------- --------             -------- -------- --------
  175.    |   <-   |  drop  |   ->   |           |1 move  |2 move  |3 move  |
  176.    |  left  |  tile  |  right |           |   left |   down |  right |
  177.     -------- -------- --------             -------- -------- --------
  178.                                           |0                |
  179.                                           |  drop tile      |
  180.                                            -----------------
  181.  
  182. * To pause the game, simply deactivate the WinTris game window.
  183.   Some multitasking programs automatically activate their own window when
  184.   they have finished working; for example some backup programs do so when
  185.   they want to have more disks to eat. In such cases WinTris will immediately
  186.   freeze and wait until you reactivate its game window. After that, it will
  187.   switch into "Get Ready" mode.
  188.   Cunning, eh?
  189.  
  190. * The level will be raised every 20 lines you complete.
  191.   There are 8 levels (0-7). The higher the level, the higher is the score you
  192.   get for every achievement.
  193.  
  194. * No Tetris docs here, I guess everyone knows what it's about. If you don't,
  195.   just check out the game, you'll soon get into it.
  196.   It's SO easy and SO fascinating!
  197. ------------------------------------------------------------------------------
  198.  
  199.  7. Known bugs
  200. ------------------------------------------------------------------------------
  201. * none, I hope I got 'em all!
  202.  
  203. - If you find a bug, please tell me: On what configuration, what kind of bug,
  204.   and in which situation. Bug reports are welcome!
  205. ------------------------------------------------------------------------------
  206.  
  207.  8. Plans for the future
  208. ------------------------------------------------------------------------------
  209.   * Joystick support: Is this really necessary?
  210.  
  211.   * Configurable keys: Some guys wanted it, maybe in the next version...
  212.  
  213.   * Serial link mode: play WinTris against each other!
  214.  
  215.   * German docs: Tut mir leid, als Zivi hat man nun mal nicht so viel Zeit...
  216.  
  217. Note: Most of these plans are still far away from realisation, but if you are
  218.       interested in the development of WinTris, why not write me your opinion? 
  219.       Or, even better, why not register?
  220.       See "Registration" for address.
  221. ------------------------------------------------------------------------------
  222.  
  223.  9. Copying WinTris
  224. ------------------------------------------------------------------------------
  225. WinTris is Public Domain, that means you may copy it wherever you want, use it
  226. until you just HATE Tetris, or whatever.
  227. The only thing you should care for is that WinTris may only be copied in its
  228. unmodified state and in connection with its complete drawer, preferable as LHa
  229. archive.
  230. Everyone should have the right to decide which files to keep or to delete.
  231. Also, everyone should be able to read this documentation. So it's just fair to
  232. keep everything together.
  233. ------------------------------------------------------------------------------
  234.  
  235. 10. Registration
  236. ------------------------------------------------------------------------------
  237. I really don't oblige you to send money, but IF you send me 10,- DM, you may
  238. be sure that you will be one of the first persons to receive a disk with a new
  239. version of WinTris, as soon as it is finished.
  240. Please don't tell me 10,- DM is too much for a voluntary donation.
  241.  
  242. Almost immediate answer guaranteed. No illegal stuff, please!
  243.  
  244. Write to:
  245.  
  246.   Harald Lenz
  247.   Edmund-Husserl-Str. 29
  248.   51377 Leverkusen
  249.   Germany
  250.  
  251. At the moment, you may also send an e-mail to the following address; the owner
  252. will pass it to me as soon as possible:
  253.  
  254.   wills@informatik.uni-bonn.de
  255.  
  256. ------------------------------------------------------------------------------
  257.  
  258. 11. A few wise words
  259. ------------------------------------------------------------------------------
  260. I'm sure that Commodore's death was mainly their own fault, but everyone of us
  261. should have learned his lesson as well by now! The Amiga scene was strong, but
  262. the Amiga software market is weak! 
  263.  
  264. It's just fun to be legal!
  265. ------------------------------------------------------------------------------
  266.  
  267. 12. Thanks to:
  268. ------------------------------------------------------------------------------
  269. * SAS Institute Inc.
  270.   for SAS-C v6.5
  271.  
  272. * Nico François
  273.   for the great ReqTools Package :-) Cool work, man!
  274.  
  275. * Jaba Development
  276.   for GadToolsBox v2.0b
  277.   (Note: GTB is fine for designing GUIs, but I prefered writing my own code.)
  278. ------------------------------------------------------------------------------
  279.  
  280. 13. Program History
  281. ------------------------------------------------------------------------------
  282.        b: minor bug fixed        c: minor change        f: minor new feature
  283.        B: major bug fixed        C: major change        F: major new feature
  284. ------------------------------------------------------------------------------
  285.  
  286. v1.0ß: - Initial release (first test phase). Hope there are no more bugs left.
  287.  
  288. v1.00: b Score measure and level 8 speed were optimized.
  289.  
  290.        b Graphics were placed wrong on BackDrop WB. Works fine now.
  291.  
  292.        b Fixed a neglectable timing problem concerning status refresh.
  293.  
  294.        c Status window now opens after game window. This is useful if you want
  295.          it to overlap the game window's titlebar after restarting WT.
  296.  
  297.        c Optimized graphics routine; should be a bit faster now.
  298.  
  299.        f Added "Clear Scores" option, menu was redesigned.
  300.  
  301.        f Now also the game borders are affected by the Interlace gadget.
  302.          Looks much better in non-interlaced mode than before.
  303.  
  304.        c Redesigned status window, removed leading zeroes.
  305.  
  306.        f Added score scrambler to keep lamers from "zapping" the file.
  307.  
  308.        c Removed slowest level; it was really tooo slow.
  309.          Changed number of lines/level from 25 to 20.
  310.          Again new score measure. (Thanx to Obiwan for these hints!)
  311.  
  312.        b Menu entry "Quit" didn't work. What a silly bug!
  313.  
  314. v1.10: F Start level may be selected.
  315.  
  316.        F Enhanced graphics system.
  317.        
  318.        C Tile size may now be changed via size gadget, field dimensions can
  319.          be set in preferences.
  320.        
  321.        f Up to 32 colours supported - should be enough, even for AGA.
  322.        
  323.        c ReqTools 2.0 used.
  324.        
  325.        f WT will now wait after returning from pause mode until a key is
  326.          pressed.
  327.          
  328.        c Tile size maximum changed from 32 to 64 pixels.
  329.        
  330.        c Field size maximum changed from 35*25 to 64*64.
  331.        
  332.        c Using new prefs will not always reset game; if so, a warning will
  333.          be displayed.
  334.          
  335.        f Mouse blanking after "Get Ready".
  336.        
  337.        c Now any key is accepted to start from "Get Ready" mode
  338.          (except Amiga-Key combinations).
  339.          
  340.        f Game Over requester.
  341.        
  342.        f File ID header on both config and hiscore files.
  343.  
  344.        c All in all, many routines have been completely rewritten.
  345.  
  346. v1.11: f Now you may again choose single-brick graphics (known from v1.00).
  347.  
  348.        f Tile Size Prediction in preferences window.
  349.  
  350.        c WinTris is no longer auto-detaching! If you really need WT running
  351.          detached from your shell, use "run WinTris".
  352.          As a result, the code is almost 2 kbyte shorter.
  353.          
  354.        f If there exists no config file (yet), WinTris decides whether to use
  355.          interlace graphics or not. This avoids a most ugly game window
  356.          popping up in MedRes Screen Mode on first startup.
  357.  
  358.        c All requesters now use the preferences system font. Since Prefs only
  359.          allows FixedWidth system default fonts, this solves the problem with
  360.          proportional fonts in the HiScore list.
  361.          
  362.        c Once again: new score measure. Now it's twice as hard to beat the
  363.          high score of 5000. But don't tell me it's impossible! 
  364.          While game-testing I achieved 5200!
  365.          (What a pity you can't recycle old score files :-)
  366.  
  367. ------------------------------------------------------------------------------
  368.        - Compiled: 07-Dec-94
  369.